OLA 文档中心

主题

2026-06-10

读取文件字符串 - ReadFileString ​

函数简介 ​

按指定编码读取文件内容，并以字符串形式返回。

接口名称 ​

ReadFileString

DLL调用 ​

c
long ReadFileString(long instance, string filePath, int encoding);

参数说明 ​

参数名类型说明
instance长整数型OLAPlug对象的指针，由 CreateCOLAPlugInterFace 接口生成。
filePath字符串要读取的文件完整路径。
encoding整数型字符编码方式：-1 自动检测；0 GBK；1 Unicode；2 UTF-8；3 UTF-8(BOM自动去除)。

示例 ​

SDK 调用 ​

cpp
#include "OLAPlugServer.h"

OLAPlugServer ola;
string content = ola.ReadFileString("config/app.ini");
csharp
using OLAPlug;

var ola = new OLAPlugServer();
string content = ola.ReadFileString("config/app.ini");
python
from OLAPlugServer import OLAPlugServer

ola = OLAPlugServer()
content = ola.ReadFileString("config/app.ini")
java
import com.olaplug.OLAPlugServer;

OLAPlugServer ola = new OLAPlugServer();
String content = ola.ReadFileString("config/app.ini");
cpp
var ola = com("OlaPlug.OlaSoft")
var content = ola.ReadFileString("config/app.ini")
vbscript
Set ola = CreateObject("OlaPlug.OlaSoft")
content = ola.ReadFileString("config/app.ini")
text
.局部变量 ola, OLAPlug
ola.创建 ()
content ＝ ola.ReadFileString(“config/app.ini“)
aardio
import OLAPlugServer;
var ola = OLAPlugServer();
var content = ola.ReadFileString("config/app.ini");
text
变量 ola <类型 = OLAPlugServer>
ola = 新建 OLAPlugServer
文本型 content = ola.ReadFileString("config/app.ini")
cpp
#include "OLAPlugServer.h"

OLAPlugServer ola;
string content = ola.ReadFileString("config/app.ini");

原生 DLL 调用 ​

cpp
long instance = CreateCOLAPlugInterFace();
long contentPtr = ReadFileString(instance, "config/app.ini");
if (contentPtr != 0) {
    char content[512] = {0};
    GetStringFromPtr(contentPtr, content, sizeof(content));
    FreeStringPtr(contentPtr);
}
csharp
using System.Runtime.InteropServices;
using System.Text;

[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int GetStringFromPtr(long ptr, StringBuilder lpString, int size);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int FreeStringPtr(long ptr);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int GetStringSize(long ptr);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern long CreateCOLAPlugInterFace();

long instance = CreateCOLAPlugInterFace();
long contentPtr = ReadFileString(instance, "config/app.ini");
if (contentPtr != 0) {
    StringBuilder content = new StringBuilder(GetStringSize(contentPtr) + 1);
    GetStringFromPtr(contentPtr, content, content.Capacity);
    FreeStringPtr(contentPtr);
    string contentStr = content.ToString();
}
python
from ctypes import CDLL, c_int, c_int64, create_string_buffer

ola = CDLL("OLAPlug_x64.dll")
ola.CreateCOLAPlugInterFace.restype = c_int64
instance = ola.CreateCOLAPlugInterFace()
contentPtr = ReadFileString(instance, "config/app.ini")
if contentPtr:
    buf = create_string_buffer(512)
    ola.GetStringFromPtr(contentPtr, buf, 512)
    ola.FreeStringPtr(contentPtr)
    content = buf.value.decode("utf-8")

返回值 ​

返回文件内容字符串的指针，失败返回0。

注意事项 ​

  • 返回的字符串指针需调用 FreeStringPtr 接口释放内存。